cURL
Python
JavaScript
PHP
Go
Java
curl --request GET \
--url https://api.zapier.com/v2/zaps \
--header 'Authorization: Bearer <token>' [
{
"data" : [
{
"id" : "00000000-0000-c000-8000-000000012345" ,
"type" : "zap" ,
"links" : {
"html_editor" : "https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345"
} ,
"steps" : [
{
"action" : "uag:1f188536-6dd0-4172-8414-2b90914ddee9" ,
"inputs" : {
"deal_stage" : "CLOSED_WON"
} ,
"authentication" : "b3eYnwl"
} ,
{
"action" : "uag:1f188536-6dd0-4172-8414-2b90914ddaa7" ,
"inputs" : {
"full_name" : "{{customer__full_name}}"
} ,
"authentication" : "BRn9rRg"
}
] ,
"title" : "My Zap" ,
"is_enabled" : false ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"last_successful_run_date" : "2019-08-24T14:15:22Z"
}
] ,
"meta" : {
"count" : 133 ,
"limit" : 10 ,
"offset" : 10
} ,
"links" : {
"next" : "https://api.zapier.com/v2/zaps?offset=20&limit=10" ,
"prev" : "https://api.zapier.com/v2/zaps?offset=0&limit=10"
}
}
] This API is rate limited .
See our OAuth2 authentication documentation
A comma separated list of Zap fields that should be expanded from ids to full objects in the response. Fields that may not be expanded will remain as ids.
If true, all Zaps that are shared with the user, rather than only those owned by them, are returned. If the zap:account:all scope is not present this has no effect.
You may pass inputs[KEY]=VALUE1,VALUE2 to filter for Zaps that contain those settings. Keys are defined by your app on the developer platform.
Used for paginating results. Specifies the maximum number of items to return per page. If this value is not set, it defaults to 10.
Used for paginating results. Specifies the offset to use.
A Zap is an automated workflow that connects your apps and services together.
A unique identifier of the Zap.
data. last_successful_run_date
The date/time at which this Zap last ran successfully. A null value indicates that a Zap has never run successfully.
The human readable name of the Zap.
ExpandedZapStep (Expandable)
The developer provided identifier for this Action
data.steps.action.app. image
Default image/icon to represent the app.
data.steps.action.app. links
A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.
If value is `null`, then no authentication is required to use the app.
data.steps.action.app. action_types
data.steps.action.app. title
Human readable name of the app
data.steps.action.app. images
Images/icons of various resolutions to represent the app.
data.steps.action.app. hex_color
A branded color that can be used to represent the app.
data.steps.action.app. categories
A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.
Category an app belongs to.
data.steps.action.app. description
Human readable description of the app.
data.steps.action.app. type
Available options:
action
data.steps.action. action_type
The type of this Action
READ - READWRITE - WRITE Available options:
action
data.steps.action. is_instant
Will be set to true if this Action triggers instantly. May only be true when type is READ.
The title of this Action.
data.steps.action. description
A longer description of this Action, usually describing what it does in more detail.
data.steps. authentication
Authentication (Expandable)
data.steps.authentication. type
enum<string>
default: authentication
required The type of this object.
authentication - authentication Available options:
authentication
data.steps.authentication. id
data.steps.authentication. app
An app that integrates with Zapier. (Expandable)
data.steps.authentication.app. id
data.steps.authentication.app. image
Default image/icon to represent the app.
data.steps.authentication.app. links
A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.
If value is `null`, then no authentication is required to use the app.
data.steps.authentication.app. action_types
data.steps.authentication.app. title
Human readable name of the app
data.steps.authentication.app. images
Images/icons of various resolutions to represent the app.
data.steps.authentication.app. hex_color
A branded color that can be used to represent the app.
data.steps.authentication.app. categories
A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.
Category an app belongs to.
data.steps.authentication.app. description
Human readable description of the app.
data.steps.authentication.app. type
data.steps.authentication. is_expired
If true, this Authentication has expired. It will not be usable, and the user needs to be directed to reconnect it.
data.steps.authentication. title
The custom title of a Zap Step. If a step has not been given a custom title by the user, then the value will be null.
Whether the Zap is enabled (running) or not.
